Introduce cookbook documentation #1826
Conversation
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
5 times, most recently
from
9cc6c95 to
cfeb25a
Compare
|
I'll review tomorrow or tuesday in depth.. but the overall mood: i love it ! |
ux.symfony.com/assets/images/cookbook/component_architecture.png
Outdated
Show resolved
Hide resolved
|
It's a bit related to the PR #1347? |
A bit .. but the "recipe" term refer to a "cookbook recipe" more than a "component recipe" :) |
There was a problem hiding this comment.
I love this @WebMamba!
I'm thinking, accross the board, we should use the term "cookbook" to not be confused with the future "recipes" idea.
For the markdown, take a look at the front matter extension. I think this could be leveraged here.
|
How do you want to proceed @WebMamba here ? Do we review both content / feature here ? Or you prefer just the "code" part for now maybe ? |
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
2 times, most recently
from
74fd42d to
4552ab1
Compare
|
@smnandre lets focus on the code at first, and then on the content. Even if we do that in two times, I can keep the content of the recipe on this PR, I think it's better if we launch the cookbook with a first article. @kbond thanks, I use the front matter extension now, this is pretty cool! @codisart thanks for your review I applied your fix! |
|
As soon as i find 15mn i'll review it i swear 😮💨 |
| @@ -0,0 +1,66 @@ | |||
| .Recipe { | |||
There was a problem hiding this comment.
Ok for you if i create some generic "content page CSS base" ? I fear we have a lot of similar "component" like this one ?
ux.symfony.com/assets/images/cookbook/component_architecture.png
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
So at lot of comments, but this is not to discourage you :)
I'll open some PR this week-end that would probably remove a lot of them (some generic system based on your work to load content, list them, cache them....)
And i'll try to adapt "CodeBlock" to remove the requirement of having a file.
And i really like lots of small improvements / ideas this PR brings 😄
|
|
||
| ***How does it work into Symfony?*** | ||
|
|
||
| Let's take the example of the Alert component an [anonymous component](https://symfony.com/bundles/ux-twig-component/current/index.html#anonymous-components). |
There was a problem hiding this comment.
Should we find a system for generic local links ?
There was a problem hiding this comment.
I don't get what you mean. Do you implements something to generate better link to the docs ?
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
from
4552ab1 to
9be6a1f
Compare
|
I am back on this @smnandre I addressed most of your comment, I think I may need some help with the css to make think a bit more prettier |
With pleasure (and it's time we move forward this project -- sorry last weeks have been really busy). This week-end i'll have time to work on this 😽 |
WebMamba
force-pushed
the
introduce_cookbook_documentation
branch
2 times, most recently
from
e995211 to
2f86503
Compare
kbond
force-pushed
the
introduce_cookbook_documentation
branch
from
2f86503 to
6bfa523
Compare
|
Thanks Matheo. |
This PR introduces a new section for the UX website: cookbook. This section aims to give more concrete documentation, show examples of common things implemented with UX components, and go deeper into some concepts that we do in the documentation. The goal is not to replace the documentation but to illustrate
the documentation with concrete examples.
How it's implemented?
Simply by creating a .md file in the recipes directory at the route of the project, then everything is generated automatically. There are cookbook pages that show all the recipes available, then you can click on the recipe to read it.
Who can add recipes to the cookbook?
Anyone! If you thing you implemented something a bit complex but common, just show you did it!
Thank you!
Tell me what you think 😁